Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation and example code for projectReferences #1184

Merged
merged 3 commits into from
Sep 14, 2020
Merged

Add documentation and example code for projectReferences #1184

merged 3 commits into from
Sep 14, 2020

Conversation

appzuka
Copy link
Member

@appzuka appzuka commented Sep 9, 2020

I have added a new document, REFERENCES.md and linked to it from the main README.md. I have also added an example to the examples/ folder.

Please feel free to make any changes to the wording/formatting/structure as appropriate.

@johnnyreilly
Copy link
Member

This is fantastic work! I need to give it a proper read but thanks so much already ❤️🌻

Copy link
Member

@johnnyreilly johnnyreilly left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left some comments - this is great stuff BTW!

REFERENCES.md Outdated
@@ -0,0 +1,329 @@

# Using TypeScript Project References with ts-loader and Webpack
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lowercase w for webpack please; surprising though it may be, that's the official casing

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll make this change throughout the document.


### Configure and build the project references

This stage just involves following the directions from the TypeScript documentation:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As I understand it from the "Using ts-loader to build project references" section, following the approach prior to that is an alternative approach that could be used and also probably not the one people will likely go for. ts-loader building references is just going to be simpler (my presumption)

As such, is it worth calling out here that these docs are going to outline 2 approaches more explicitly?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wanted to show how to configure using tsc --build because you need to get that part right or nothing is going to work. It is also helpful to check that it is working with tsc independently if you are having problems. Once it is working I believe most people would use ts-loader.

I'll amend the docs to make it clear I am not proposing 2 alternatives.

@johnnyreilly johnnyreilly merged commit f8eba53 into TypeStrong:master Sep 14, 2020
@johnnyreilly
Copy link
Member

This is awesome - thanks @appzuka!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants